Package pl.wendigo.chrome.api.overlay

Contains DevTools Protocol Overlay domain implementation accessible via OverlayDomain class.

Types

BoxStyle

data class BoxStyle(fillColor: RGBA?, hatchColor: RGBA?)

Style information for drawing a box.

ColorFormat

enum ColorFormat : Enum<ColorFormat>

ContrastAlgorithm

enum ContrastAlgorithm : Enum<ContrastAlgorithm>

FlexContainerHighlightConfig

data class FlexContainerHighlightConfig(containerBorder: LineStyle?, lineSeparator: LineStyle?, itemSeparator: LineStyle?, mainDistributedSpace: BoxStyle?, crossDistributedSpace: BoxStyle?, rowGapSpace: BoxStyle?, columnGapSpace: BoxStyle?, crossAlignment: LineStyle?)

Configuration data for the highlighting of Flex container elements.

FlexItemHighlightConfig

data class FlexItemHighlightConfig(baseSizeBox: BoxStyle?, baseSizeBorder: LineStyle?, flexibilityArrow: LineStyle?)

Configuration data for the highlighting of Flex item elements.

FlexNodeHighlightConfig

data class FlexNodeHighlightConfig(flexContainerHighlightConfig: FlexContainerHighlightConfig, nodeId: NodeId)

GetGridHighlightObjectsForTestRequest

data class GetGridHighlightObjectsForTestRequest(nodeIds: List<NodeId>)

Represents request frame that can be used with Overlay#getGridHighlightObjectsForTest operation call.

GetGridHighlightObjectsForTestResponse

data class GetGridHighlightObjectsForTestResponse(highlights: JsonElement)

Represents response frame that is returned from Overlay#getGridHighlightObjectsForTest operation call.

GetHighlightObjectForTestRequest

data class GetHighlightObjectForTestRequest(nodeId: NodeId, includeDistance: Boolean?, includeStyle: Boolean?, colorFormat: ColorFormat?, showAccessibilityInfo: Boolean?)

Represents request frame that can be used with Overlay#getHighlightObjectForTest operation call.

GetHighlightObjectForTestResponse

data class GetHighlightObjectForTestResponse(highlight: JsonElement)

Represents response frame that is returned from Overlay#getHighlightObjectForTest operation call.

GetSourceOrderHighlightObjectForTestRequest

data class GetSourceOrderHighlightObjectForTestRequest(nodeId: NodeId)

Represents request frame that can be used with Overlay#getSourceOrderHighlightObjectForTest operation call.

GetSourceOrderHighlightObjectForTestResponse

data class GetSourceOrderHighlightObjectForTestResponse(highlight: JsonElement)

Represents response frame that is returned from Overlay#getSourceOrderHighlightObjectForTest operation call.

GridHighlightConfig

data class GridHighlightConfig(showGridExtensionLines: Boolean?, showPositiveLineNumbers: Boolean?, showNegativeLineNumbers: Boolean?, showAreaNames: Boolean?, showLineNames: Boolean?, showTrackSizes: Boolean?, gridBorderColor: RGBA?, cellBorderColor: RGBA?, rowLineColor: RGBA?, columnLineColor: RGBA?, gridBorderDash: Boolean?, cellBorderDash: Boolean?, rowLineDash: Boolean?, columnLineDash: Boolean?, rowGapColor: RGBA?, rowHatchColor: RGBA?, columnGapColor: RGBA?, columnHatchColor: RGBA?, areaBorderColor: RGBA?, gridBackgroundColor: RGBA?)

Configuration data for the highlighting of Grid elements.

GridNodeHighlightConfig

data class GridNodeHighlightConfig(gridHighlightConfig: GridHighlightConfig, nodeId: NodeId)

Configurations for Persistent Grid Highlight

HighlightConfig

data class HighlightConfig(showInfo: Boolean?, showStyles: Boolean?, showRulers: Boolean?, showAccessibilityInfo: Boolean?, showExtensionLines: Boolean?, contentColor: RGBA?, paddingColor: RGBA?, borderColor: RGBA?, marginColor: RGBA?, eventTargetColor: RGBA?, shapeColor: RGBA?, shapeMarginColor: RGBA?, cssGridColor: RGBA?, colorFormat: ColorFormat?, gridHighlightConfig: GridHighlightConfig?, flexContainerHighlightConfig: FlexContainerHighlightConfig?, flexItemHighlightConfig: FlexItemHighlightConfig?, contrastAlgorithm: ContrastAlgorithm?)

Configuration data for the highlighting of page elements.

HighlightFrameRequest

data class HighlightFrameRequest(frameId: FrameId, contentColor: RGBA?, contentOutlineColor: RGBA?)

Represents request frame that can be used with Overlay#highlightFrame operation call.

HighlightNodeRequest

data class HighlightNodeRequest(highlightConfig: HighlightConfig, nodeId: NodeId?, backendNodeId: BackendNodeId?, objectId: RemoteObjectId?, selector: String?)

Represents request frame that can be used with Overlay#highlightNode operation call.

HighlightQuadRequest

data class HighlightQuadRequest(quad: Quad, color: RGBA?, outlineColor: RGBA?)

Represents request frame that can be used with Overlay#highlightQuad operation call.

HighlightRectRequest

data class HighlightRectRequest(x: Int, y: Int, width: Int, height: Int, color: RGBA?, outlineColor: RGBA?)

Represents request frame that can be used with Overlay#highlightRect operation call.

HighlightSourceOrderRequest

data class HighlightSourceOrderRequest(sourceOrderConfig: SourceOrderConfig, nodeId: NodeId?, backendNodeId: BackendNodeId?, objectId: RemoteObjectId?)

Represents request frame that can be used with Overlay#highlightSourceOrder operation call.

HingeConfig

data class HingeConfig(rect: Rect, contentColor: RGBA?, outlineColor: RGBA?)

Configuration for dual screen hinge

InspectMode

enum InspectMode : Enum<InspectMode>

InspectNodeRequestedEvent

data class InspectNodeRequestedEvent(backendNodeId: BackendNodeId) : Event

Fired when the node should be inspected.

LineStyle

data class LineStyle(color: RGBA?, pattern: String?)

Style information for drawing a line.

NodeHighlightRequestedEvent

data class NodeHighlightRequestedEvent(nodeId: NodeId) : Event

Fired when the node should be highlighted.

OverlayDomain

class OverlayDomain : Domain

This domain provides various functionality related to drawing atop the inspected page.

ScreenshotRequestedEvent

data class ScreenshotRequestedEvent(viewport: Viewport) : Event

Fired when user asks to capture screenshot of some area on the page.

SetInspectModeRequest

data class SetInspectModeRequest(mode: InspectMode, highlightConfig: HighlightConfig?)

Represents request frame that can be used with Overlay#setInspectMode operation call.

SetPausedInDebuggerMessageRequest

data class SetPausedInDebuggerMessageRequest(message: String?)

Represents request frame that can be used with Overlay#setPausedInDebuggerMessage operation call.

SetShowAdHighlightsRequest

data class SetShowAdHighlightsRequest(show: Boolean)

Represents request frame that can be used with Overlay#setShowAdHighlights operation call.

SetShowDebugBordersRequest

data class SetShowDebugBordersRequest(show: Boolean)

Represents request frame that can be used with Overlay#setShowDebugBorders operation call.

SetShowFlexOverlaysRequest

data class SetShowFlexOverlaysRequest(flexNodeHighlightConfigs: List<FlexNodeHighlightConfig>)

Represents request frame that can be used with Overlay#setShowFlexOverlays operation call.

SetShowFPSCounterRequest

data class SetShowFPSCounterRequest(show: Boolean)

Represents request frame that can be used with Overlay#setShowFPSCounter operation call.

SetShowGridOverlaysRequest

data class SetShowGridOverlaysRequest(gridNodeHighlightConfigs: List<GridNodeHighlightConfig>)

Represents request frame that can be used with Overlay#setShowGridOverlays operation call.

SetShowHingeRequest

data class SetShowHingeRequest(hingeConfig: HingeConfig?)

Represents request frame that can be used with Overlay#setShowHinge operation call.

SetShowHitTestBordersRequest

data class SetShowHitTestBordersRequest(show: Boolean)

Represents request frame that can be used with Overlay#setShowHitTestBorders operation call.

SetShowLayoutShiftRegionsRequest

data class SetShowLayoutShiftRegionsRequest(result: Boolean)

Represents request frame that can be used with Overlay#setShowLayoutShiftRegions operation call.

SetShowPaintRectsRequest

data class SetShowPaintRectsRequest(result: Boolean)

Represents request frame that can be used with Overlay#setShowPaintRects operation call.

SetShowScrollBottleneckRectsRequest

data class SetShowScrollBottleneckRectsRequest(show: Boolean)

Represents request frame that can be used with Overlay#setShowScrollBottleneckRects operation call.

SetShowViewportSizeOnResizeRequest

data class SetShowViewportSizeOnResizeRequest(show: Boolean)

Represents request frame that can be used with Overlay#setShowViewportSizeOnResize operation call.

SetShowWebVitalsRequest

data class SetShowWebVitalsRequest(show: Boolean)

Represents request frame that can be used with Overlay#setShowWebVitals operation call.

SourceOrderConfig

data class SourceOrderConfig(parentOutlineColor: RGBA, childOutlineColor: RGBA)

Configuration data for drawing the source order of an elements children.